package com.sss.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * @ClassName SwaggerConfig
 * @Description TODO
 * @Author 沈世举
 * @Date 2020/12/8 13:38
 * @Version 1.0
 */

/**
 * 总结：
 *  1.我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息
 *  2.接口文档实时更新
 *  3.可以在线测试
 * 注意：
 *  在正式发布的时候，要关闭Swagger，出于安全考虑，节省运行内存
 */
@Configuration
@EnableSwagger2   //开启Swagger2
public class SwaggerConfig {

    /**配置了swagger的Docket的bean实例*/
    @Bean
    public Docket docket(Environment environment) {

        //设置要显示的Swagger环境
        Profiles profiles = Profiles.of("dev");

        //获取项目的环境，通过environment.acceptsProfiles(profiles);返回值，判断是否处在自己设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("沈世举")
                //.enable() 是否启动Swagger，如果为false，则Swagger 不能在浏览器中访问
                .enable(flag)
                .select()
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                //basePackage ：指定要扫描的包
                //any() ：扫描全部
                //none() ：都不扫描
                .apis(RequestHandlerSelectors.basePackage("com.sss.controller"))
                //paths() 配置如何通过path过滤,即这里只扫描请求以/sss开头的接口
                //.paths(PathSelectors.ant("/sss/**"))
                .build();
    }

    //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v1.0", // 版本
                "http://terms.service.url/组织链接", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }
}
